home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 112 / EnigmaAmiga112CD.iso / dalla rivista / awnpipe / awnp / awnp-docs / commodity.doc < prev    next >
Text File  |  2000-05-14  |  2KB  |  67 lines
  1. Commodity event
  2. ----------------
  3.  
  4. Commodity    "cx TYPE [SUBTYPE]"
  5.  
  6.  TYPE=hotkey            The commodities hotkey has been detected.
  7.  TYPE=kill              The commodity has been requested to quit.
  8.  TYPE=unique            Another commodity with the same name tried to start (but always fails)
  9.  TYPE=show              The commodity has been requested to show its GUI.
  10.  TYPE=hide              The commodity has been requested to hide its GUI.
  11.  TYPE=disable           The commodity has been disabled.
  12.  TYPE=enable            The commodity has been enabled.
  13.  
  14.  
  15.  With dis/enable your commodity is automatically enabled or disabled. You MUST respect this in your program. With other commodity events you SHOULD TRY to react in some proper way.
  16.  
  17.  The next three types are included to alow for future enhancements of the Amiga Commodity ability.
  18.  
  19.  TYPE=command SUBTYPE   The commodity has received an unrecognized command. The subtype is the messageID.
  20.  TYPE=event SUBTYPE     The commodity has received an unrecognized event. The subtype is the messageID.
  21.  TYPE= NUMBER SUBTYPE   The commodity has received an unrecognized message type. Number is the message type, subtype is the messageID.
  22.  
  23. Commodity parameters
  24. --------------------
  25.  
  26. You may only create one commodity object, per GUI.
  27.  
  28. CxName="name"
  29.  
  30. Name Commodities uses to identify this commodity.(REQUIRED)
  31.  
  32. CxPri=number
  33.  
  34. The priority of your commodity, defaults to 0.
  35.  
  36. CxTitle="title"
  37.  
  38. Title of commodity that appears in CXExchange.
  39.  
  40. CxDesc="description"
  41.  
  42. Description of the commodity.
  43.  
  44. CxHotkey=" hotkey description"
  45.  
  46. example  CxHotKey="ctrl alt f1"
  47.  
  48. CxNoGui
  49.  
  50. Do not allow CXExchange to request GUI open and closing.
  51.  
  52. Definition Reply
  53. -----------------
  54.  
  55.  When the commodity creation is successful the pipe replies with
  56.  
  57. 'ok'
  58.  
  59. Modify parameters
  60. -----------------
  61.  
  62. Normally you should not need to disable or enable your commodity as it is handled automatically. This gives you the ability to override the automatic control, use it carefully.
  63.  
  64. Commodity=number
  65.  
  66. If number =0 then disable the commodity, else enable the commodity. Replied to with ok.
  67.